home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / news320a.zip / NEWSMAN.DOC < prev    next >
Text File  |  1992-01-16  |  18KB  |  427 lines
  1.  
  2.                              N E W S  M A N A G E R
  3.                                   Version 3.20
  4.                         Re-Release Date: January 16, 1992
  5.  
  6.                 (C) Copyright 1988, 1989, 1992 - All Rights Reserved
  7.  
  8.                               a PCBoard/GAP door
  9.  
  10.                            written By Kevin C. Carr
  11.  
  12.  
  13. ===============================================================================
  14. FEATURES
  15. ~~~~~~~~
  16.   ▐ Allows up to 999 News Entries.
  17.  
  18.   ▐ Support for PCBoard, GAP, or ANY BBS Local Mode.
  19.  
  20.   ▐ Password protection on any or all News Files.
  21.  
  22.   ▐ Support to delete old news.
  23.  
  24.   ▐ Support to make certain News entries expire on a certain date.
  25.  
  26.   ▐ Premanent News entries.
  27.  
  28.   ▐ Color and non-color News files.
  29.  
  30.   ▐ Two different News Styles to choose from.
  31.  
  32.   ▐ Colors of the News are completely definable.
  33.  
  34.   ▐ Support for locked ports up to 38.4K.  Unlimited com ports.
  35.  
  36.   ▐ Many, Many, Many More!
  37.  
  38.  
  39. ===============================================================================
  40. SUPPORT
  41. ~~~~~~~
  42.    Call:
  43.        User-To-User BBS
  44.        (214)492-6565, 14400 HST/v32bis
  45.        (214)492-5695, Hayes 9600 v42
  46.        RIME ->UTOU
  47.        FidoNet 1:124/1010
  48.  
  49.    Or Write:
  50.        Kevin C. Carr
  51.        P.O. Box 7376
  52.        Denton, TX  76203-2376
  53.  
  54.  
  55. ===============================================================================
  56. SETUP
  57. ~~~~~
  58.    News Manager needs a configuartion file to operate.  Configuration files
  59.    can be called anything you want, but I will address them as NEWSMAN.CFG.
  60.    A sample NEWSMAN.CFG has been included with this door to serve as a
  61.    guideline.  The format of the NEWSMAN.CFG is as follows:
  62.  
  63. Line #    Example               Description
  64. --------  --------------------  ---------------------------------------------
  65.    1      C:\PCB                The Full Path of PCBOARD.SYS, DOOR.SYS,
  66.                                 or 'LOCAL'
  67.    2      User-To-User          Name of your BBS
  68.    3      1                     '0' = GAP, '1' = PCBoard, '2' = Local
  69.    4      William Pendergast    Sysop's FULL Name
  70.    5      BLUE                  Color of lines in news (borders)
  71.    6      YELLOW                Color of numbers in date of news
  72.    7      MAGENTA               Color of dashes in date of news
  73.    8      WHITE                 Color of text in news
  74.    9      RED                   Color of description in news
  75.   10      2                     Default News Type (1,2,3,4)
  76.   11                            Registration Code or leave it blank
  77.  
  78. The above is the main part of the configuration file.  You must now setup
  79. the News File names.  To support a News File, the door needs to know the
  80. News File Description, Non-Color News Filename, Color News Filename, and
  81. the password required to access the News File (blank=none).  You can have
  82. as little as 1 News File support, or as many as 99 News Files.  You put the
  83. information at the end of the NEWSMAN.CFG file like:
  84.  
  85. Line #    Example               Description
  86. --------  --------------------  ---------------------------------------------
  87.   12      Main Board News       General Description of the News
  88.   13      NEWS1                 Prefix of news data files (MUST BE DIFFERENT
  89.                                 FOR EACH DIFFERENT NEWS FILE!)
  90.   14      M:\PCB\GEN\NEWS       Path/Filename for Non-Color News
  91.   15      M:\PCB\GEN\NEWSG      Path/Filename for Color News
  92.   16      PASSWORD              Password for this news entry (blank=none)
  93.                                 Notice, News Manager compares the
  94.                                 complete line to the one entered, so
  95.                                 watch out for hidden spaces at the end
  96.                                 of this line.
  97.  
  98. For ever extra news file you support, the NEWSMAN.CFG should be increased
  99. by five lines, and include all five lines of the above required information.
  100.  
  101.  
  102. Line #1: If you are running a PCBoard, this line should ONLY include the path
  103.          of the PCBOARD.SYS file, like 'C:\PCB', **NOT** 'C:\PCB\PCBOARD.SYS'!
  104.          (Support for PCBoard 14.x)
  105.  
  106.          If you are running a GAP BBS, this line should ONLY include the
  107.          path of the DOOR.SYS file, like 'C:\GAP', **NOT** 'C:\GAP\DOOR.SYS'!
  108.          (Support for GAP 3.x-4.x)
  109.  
  110.          If you would like to run the door locally, this line can
  111.          contain anything you wish.
  112.  
  113. Line #2: Simply put your BBS name.  If you are a registered News Manager
  114.          user, your BBS *must* be spelled exactly the same way as you gave
  115.          me the information, or News Manager will say 'Un-Registered'.
  116.  
  117. Line #3: Put a '0' if you are running a GAP 4.0+, a '1' for PCB 14
  118.          systems, and a '2' for Local Only mode.
  119.  
  120. Line #4: This is where you tell me the sysops name.  If you are a
  121.          registered NEWSMAN user, your name must be spelled exactly the
  122.          same way as you gave me the information, or News Manager will
  123.          say 'Un-Registered'.
  124.  
  125. Line #5: Your options on this line are either RED, WHITE, BLUE, MAGENTA,
  126.          YELLOW, or GREEN.  The above colors are the brighter (bold) colors.
  127.          If you would like other colors that are not supported here, simply
  128.          put the desired escape code on this line.
  129.  
  130. Line #6: Same as Line #5
  131. Line #7: Same as Line #5
  132. Line #8: Same as Line #5
  133. Line #9: Same as Line #5
  134.  
  135. Line #10: Four News File formats are currently support.  This line should
  136.           contain the DEFAULT News File Style Type, therefore, '1' or
  137.           '2'.  The styles can be found later in the docs.
  138.  
  139. Line #11: Used for Registered News Manager Boards only.  Leave this blank if
  140.           you have not registered News Manager.  Be sure that you put
  141.           the correct code in.  They are tricky little suckers.
  142.  
  143.  
  144. All lines after this configure News Files.
  145.  
  146. You can run News Manager by simply putting the following in your door batch
  147. file, or by typing the following manually:
  148.  
  149.      'NEWSMAN.EXE NEWSMAN.CFG'
  150.  
  151.   Of course, you should replace NEWSMAN.CFG with the name of your
  152.   configuration filename.
  153.  
  154.  
  155. ===============================================================================
  156. NEWS MANAGER FILES
  157. ~~~~~~~~~~~~~~~~~~
  158.    Filename          Description
  159.    ----------------  --------------------------------------
  160.    NEWSMAN.EXE       News Manager Executable Program
  161.    NEWSMAN.DOC       News Manager Documentation
  162.    NEWSMAN.CFG       News Manager Sample Configuration File
  163.    REGISTER.FRM      Registration Form - Please support Shareware!
  164.  
  165. ===============================================================================
  166. DAILY MAINTENANCE (Optional)
  167. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  168.   If you use the expiration dates on News entries & your BBS supports nightly
  169.   events, it is recommended that you read this section of the docs.  If for
  170.   some reason, your BBS does not support nightly events, you should run
  171.   News Manager manually and select the [R]enumber option from the main menu
  172.   of each individual News file.  If you simply do not want to support
  173.   expiration dates, you can totally ignore this section.
  174.  
  175.   The Daily Maintenance routines will go through each News entry that is
  176.   listed in the NEWSMAN.CFG, and process each one.  It will first check
  177.   to see if any old is new, and therefore should be deleted.  It will then
  178.   create the master News files (from information in NEWSMAN.CFG).
  179.  
  180.   You should run the News Manager maintenance by putting the following in
  181.   your nightly event, or running it manually whenever you wish:
  182.  
  183.      NEWSMAN /DAILY:NEWSMAN.CFG
  184.  
  185.   Of course, you should replace NEWSMAN.CFG with the name of your
  186.   configuration filename.
  187.  
  188.  
  189. ===============================================================================
  190. NEWS ENTRY FILENAME FORMAT
  191. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  192.    Each news entry is stored in its own file.  I am taking the time to explain
  193.    all of this to you just in case you ever have the need to make changes
  194.    or additions to the news with using News Manager.
  195.  
  196.    The filename for the news files are as follows:
  197.  
  198.        [prefix].yyy   & [prefix]G.yyy
  199.        (Non-Color)       (Color)
  200.  
  201.    Each News file (five lines of NEWSMAN.CFG) is given a number.
  202.  
  203.    [prefix] stands for the news' unique prefix.
  204.  
  205.    News Manager supports up to 999 news entries in each news file.  Each
  206.    news entry is given a number from 001 to 999.  'yyy' stands for the
  207.    news entry's number.
  208.  
  209.    The first line of each file contains the expiration date for that news
  210.    entry.  Every line after that is the actual news entry.
  211.  
  212.    Both the non-color AND the color news entry files should exist, or problems
  213.    may occur!
  214.  
  215.  
  216. ===============================================================================
  217. PERMANENT NEWS ENTRY (Optional)
  218. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  219.    If you desire to have a News Entry ALWAYS stay on top, this section is for
  220.    you!  This feature can be used if you support Echomail/Netmail and you want
  221.    the last Mail Transfer Date/Time at the top of the News or for any other
  222.    reason which requires a permanent news entry.
  223.  
  224.    The permamnt News entry should be put into the files [prefix].000 &
  225.    [prefix]G.000.  Re-read the section 'NEWS ENTRY FILENAME FORMAT' if you
  226.    have forgotten what the 'x' stands for.  The difference between this file
  227.    and the rest of them is that this one does not have an expiration date on
  228.    the first line.
  229.  
  230.    I use this feature since I am part of the RelayNet.  I put the last
  231.    date/time we did a successful mail transfer at the top of the News file.
  232.    I put the following in my PCRelay batch file:
  233.  
  234.          COPY LASTTIME.TXT D:\NEWSMAN\NEWS1.000
  235.          COPY LASTTIME.TXT D:\NEWSMAN\NEWS1G.000
  236.          D:
  237.          CD\NEWSMAN
  238.          NEWSMAN /DAILY:NEWSMAN.CFG
  239.  
  240.    (Remember that News Manager needs both a color and non-color News 000)
  241.  
  242.  
  243. ===============================================================================
  244. NEWS STYLES
  245. ~~~~~~~~~~~
  246.      ┌──────────┐                                               ┌─────────────┐
  247. ─────┤ 00-00-00 ├───────────────────────────────────────────────┤ Description │
  248.      └──────────┘                                               └─────────────┘
  249.   News Style #1
  250.  
  251.  
  252.       ┌───────────────────────┐
  253.  ┌────┤ Description, 00-00-00 ├───────────────────────────────────────────────┐
  254.  │    └───────────────────────┘                                               │
  255.  │ News Style #2                                                              │
  256.  └────────────────────────────────────────────────────────────────────────────┘
  257.  
  258.  
  259. ===============================================================================
  260. NEWSMAN COMMANDS
  261. ~~~~~~~~~~~~~~~~
  262.    Main Command Menu
  263.    -----------------
  264.    ┌────────────────────────────────────────────────────────────────────────┐
  265.    │     (A)dd News, (H)elp, (G)raphics Toggle, (P)age Sysop, (R)enumber    │
  266.    │            (V)iew/Delete News, (Q)uit to Menu, (QU)it to BBS           │
  267.    └────────────────────────────────────────────────────────────────────────┘
  268.  
  269.     (A): Add News.  This is the command that allows you to add a new News
  270.          entry.
  271.  
  272.     (H): Help.  This gives a short explanation of these commands.
  273.  
  274.     (G): Graphics Toggle.  This will toggle your ANSI support On/Off.
  275.  
  276.     (P): Page Sysop.  Page the sysop to chat.
  277.  
  278.     (R): Renumber.  With this command, you can check for expired news
  279.          files, or just renumber your NEWSxx.yyy and NEWSxxG.yyy files.
  280.  
  281.     (V): View/Delete News.  This is where you can either view the complete
  282.          news file, individual news entries, or delete any news entry.
  283.  
  284.     (Q): Quit to Menu.  This will take you back to the News File selection
  285.          menu.  It will ask you if you would like to create a new news file
  286.          first.
  287.  
  288.     (QU): Quit to BBS.  Exit back to the BBS.  This command also asks you if
  289.           you would like to create a new news file.
  290.  
  291.     (*): Some general information on News Manager.
  292.  
  293.  
  294.     Add News - Message Style - Commands
  295.     -----------------------------------
  296.     (A): Abort.  Abort the news you were typing, and return to the main
  297.          menu.  News will not save.
  298.  
  299.     (C): Continue.  Continue typing news once you are at the Add News prompt.
  300.  
  301.     (D): Delete.  Delete one line out of the news you are typing.
  302.  
  303.     (E): Edit.  Edit one line of the news you are typing.
  304.  
  305.     (F): File Imp.  Import any file into the news you are typing.  If the
  306.          file is too long or too wide, News Manager will chop parts of it
  307.          off and notify you of the problem.
  308.  
  309.     (H): Help.  Short description of these commands.
  310.  
  311.     (I): Insert.  Insert one line before another line.
  312.  
  313.     (L): List.  List what you have typed so far.
  314.  
  315.     (T): Title.  Change the news title (description) or the expiration date.
  316.  
  317.     (S): Save.  Save the news & return to the main menu.
  318.  
  319.  
  320. ===============================================================================
  321. SUBSTITUTION VARIABLES
  322. ~~~~~~~~~~~~~~~~~~~~~~
  323.    Many BBSes now support something called Substitution Variables or
  324.    SmartText (whatever you wish to call it).  With PCBoard 14.2, a variable
  325.    would look something like: "@USER@".  When using the Boxed or Printer
  326.    Paper Style news formats, these variables should NOT be used since the
  327.    variables vary in length depending on who is reading it, and the variables
  328.    are usually different lengths then the actual text it displays.  This
  329.    causes the spacing to be unpredicatable!
  330.  
  331.  
  332. ===============================================================================
  333. HISTORY
  334. ~~~~~~~
  335. (Versions 1.0 to 2.3 were called Newsgen)
  336.  
  337. Ver 3.00 -  Official News Manager Release!  Because this version is
  338.             almost completely different that Newsgen, I will not list
  339.             all of the changes.  You should simply read the docs like
  340.             this was a completely new door.  If you registered NEWSGEN,
  341.             please fill out the REGISTER.FRM and tell me that you have
  342.             already sent money.  I have lost the addresses of a few
  343.             of you.  Enjoy!
  344.  
  345. Ver 3.20 -  News Manager will only update the NEWS/NEWSG file's dates/times
  346.             when new news has been added.  Therefore, no long will the
  347.             NEWS/NEWSG files have the current date/time everytime you create
  348.             it.  It will have the date of the last news entry for that
  349.             NEWS/NEWSG file.  Thanks to Rod Renner for sending me his ASM
  350.             routines to read/write dates from/to files.  You can now import
  351.             a complete file without having to worry about fitting it into
  352.             the 72 character length limit.  You can specify the name of
  353.             an ANSI and an ASCII version of the file.  News Manager now
  354.             supports up to 38.4K and unlimited com ports.  A new line
  355.             has been added to the NEWSMAN.CFG file.  You must now specify
  356.             the type of BBS you are running on line 3.  See above docs
  357.             for more information.  You no longer need the 'SET GAPQBDR='
  358.             variables!
  359.  
  360. Ver 3.20 -  Re-Released!  There are three reasons that v3.2 are being
  361.             released again.  First, I want everyone to know that News
  362.             Manager is still being supported.  Second, I would like to
  363.             notify everyone of my address change (see the end of the
  364.             documentation).  Third, I would like to get suggestions
  365.             on improvements and enhancements that could be made to
  366.             News Manager.  PLEASE contact me if you have any suggestions!
  367.  
  368. ===============================================================================
  369. BETA TESTERS
  370. ~~~~~~~~~~~~
  371.         I would like to thank the beta testers of our software.  Thanks
  372.         for helping make our doors look better!
  373.  
  374.                PCBoard User-To-User
  375.                (214)492-6565, 14.4K HST/V32bis
  376.                (214)492-5695, Hayes 9600 v42
  377.                Sysop - William Pendergast & Kevin Carr
  378.                Net - RIME ->UTOU
  379.                      FidoNet 1:124/1010
  380.  
  381.                PCBoard SALEMDUG
  382.                (202)646-2887, 9600 HST
  383.                Sysop - Rod Renner
  384.  
  385. If you are interested in being a beta tester, please contact me on the BBS
  386. below.  If you are a beta tester and NOT listed above, please notify me!
  387.  
  388. ===============================================================================
  389. DISTRIBUTION
  390. ~~~~~~~~~~~~
  391.         NEWS MANAGER is Copyrighted by Carr Software & Kevin C. Carr,
  392.         with all rights reserved.  This program is being distributed
  393.         via the SHAREWARE concept and as such, may be copied freely
  394.         with the following restrictions:
  395.  
  396.                 * The program must be supplied in it's original
  397.                   unmodified form, including documentation.
  398.  
  399.                 * No fee is charged for distribution.
  400.  
  401.                 * NEWS MANAGER may not be distributed as part of any
  402.                   other application or service without the express
  403.                   written consent of the author.
  404.  
  405.    THIS PROGRAM IS NOT A DEMO.  IT INCLUDES NO EXPIRATION OR  "CRIPPLEWARE"
  406.    CODE WHATSOEVER.  REGISTRATION IS OPTIONAL, BUT RECOMMENDED BECAUSE....
  407.  
  408.         NEWS MANAGER represents many hours of programming and the author
  409.         deserves just compensation for his time, efforts and expertise.
  410.         If you find this program to be of some value and you continue
  411.         to use it on your BBS system, you must return the registration
  412.         form provided along with the $15.00+ registration fee.  This small
  413.         fee will ensure future doors/utilities from us.
  414.  
  415.         Authors: I will give registered copies of my software to any
  416.                  author who sends me registered software of his software.
  417.  
  418.       Suggestions, comments, bug notices, etc. may be sent to the address
  419.                           below or via electronic mail.
  420.  
  421.                   (Checks should be made out to Kevin C. Carr)
  422.  
  423.                                 Kevin C. Carr
  424.                                 P.O. Box 7376
  425.                          Denton, Texas  76203-2376
  426.  
  427.